Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New website #867

Merged
merged 14 commits into from
May 23, 2023
Merged

New website #867

merged 14 commits into from
May 23, 2023

Conversation

amacneil
Copy link
Contributor

@amacneil amacneil commented Mar 27, 2023 •
edited
Loading

  1. Migrated MCAP website from mkdocs to docusaurus

    • Consistent with what we are using to generate Foxglove API docs
    • Ability to easily integrate React components, with full support for server side rendering
    • Foxglove team has much more familiarity with TypeScript/React than Python
    • Cleaner URLs

  2. Migrated hosting from GitHub Pages to Cloudflare Pages

    • Supports PR preview deployments

  3. Removed self-hosted rust docs in favor of https://docs.rs/mcap/

    • Easier to show the latest released version (not main) and browse docs from previous versions
    • Same pattern we use for Go docs

  4. Updated copy

    • New homepage
    • Integrated mcap CLI docs into website
    • Fixed links and formatting due to website migration

Preview deployment here: https://adrian-website.mcap.pages.dev/

@amacneil amacneil force-pushed the adrian/website branch 7 times, most recently from 02e86bf to 50a2519 Compare March 27, 2023 04:42
@amacneil amacneil temporarily deployed to Preview March 27, 2023 04:42 — with GitHub Actions Inactive
@amacneil amacneil temporarily deployed to Preview March 27, 2023 04:43 — with GitHub Actions Inactive
@amacneil amacneil temporarily deployed to Preview March 27, 2023 04:50 — with GitHub Actions Inactive
@amacneil amacneil temporarily deployed to Preview March 27, 2023 04:51 — with GitHub Actions Inactive
@amacneil amacneil temporarily deployed to Preview March 27, 2023 05:06 — with GitHub Actions Inactive
@amacneil amacneil temporarily deployed to Preview March 27, 2023 05:32 — with GitHub Actions Inactive
@amacneil @jtbandes
Update website/src/pages/index.tsx
26f06b6 
Co-authored-by: Jacob Bandes-Storch <[email protected]>
@jtbandes
Copy link
Member

jtbandes commented May 22, 2023 •
edited
Loading

still got some green
image
image

@amacneil
Copy link
Contributor Author

👍 I think the CLI docs seem out of place under guides, I'd put them as another heading in the topnav.

Yeah I tried this, it felt pretty lonely (e.g. left sidebar only has one item). If the CLI docs were fleshed out with multiple pages of content I think it would work. Could always do that later.

@amacneil
Copy link
Contributor Author

amacneil commented May 23, 2023 •
edited
Loading

still got some green

I decided to embrace the green and remove the purple. It looks decent for now and we can always change colors in a follow up PR.

jtbandes
jtbandes approved these changes May 23, 2023
View reviewed changes
.github/workflows/ci.yml Show resolved Hide resolved
.github/workflows/website.yml Outdated Show resolved Hide resolved
@jtbandes
Copy link
Member

Why Cloudflare Pages as opposed to GitHub pages or something else?

@amacneil
Copy link
Contributor Author

Why Cloudflare Pages as opposed to GitHub pages or something else?

Per PR description - "Supports PR preview deployments", that is the only reason. GitHub Pages seems to be an abandoned product, surprised they haven't shipped more features to become competitive with Vercel etc.

I did originally use Vercel for the deployment, but wasn't excited that they share a deploy key across all projects in the org which seemed non-ideal for security.

@amacneil amacneil merged commit a745fe1 into main May 23, 2023
@amacneil amacneil deleted the adrian/website branch May 23, 2023 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@defunctzombie defunctzombie defunctzombie left review comments

@jtbandes jtbandes jtbandes approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@amacneil @jtbandes @james-rms @defunctzombie